status-service API

status-service supports 5 commands:

Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index

/epe/status/statushistory POST version		Input:	Output:
	Description: Lists status history. Role Required: viewer Call Counter: Total: 0, Failed: 0	tagid (optional) - [Array] list entries related to specific devices, specified by device ids mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses since (optional) - [String] list entries since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list entries until the specified time. format is the same as with since within (optional) - [String] list entries occured within the given time period, format 1s for one second, 2m for two minutes, 3h for three hours, 4d for four days time (optional) - [long] status change entry timestamp numlatest (optional) - [int] max number of entries to list, newest first numoldest (optional) - [int] max number of entries to list, oldest first sort (optional) - [String] sorts output into given order. Allowed values are 'ascending' and 'descending'. Can not be used simultaneously with 'numlatest' or 'numoldest' streaming (optional) - [String] if set to true, returns history as a stream format (optional) - [String] format of output, compact or xml; default is xml	TAGSTATUS.tagid - [long] id of a device TAGSTATUS.assetid - [long] asset identifier TAGSTATUS.mac - [String] MAC address of a device TAGSTATUS.time - [String] entry time stamp in milliseconds since January 1, 1970, 00:00:00 GMT TAGSTATUS.reason - [String] description of the reason for status change TAGSTATUS.statustype - [Array] type of status that was changed (such as Dirtiness) TAGSTATUS.status - [Array] new status value (such as Clean) TAGSTATUS.statustime - [Array] status change time in milliseconds since January 1, 1970, 00:00:00 GMT
/epe/status/statusstream POST version		Input:	Output:
	Description: Receive new process status change events in real time. The connection stays active forever. Whenever a new status update is available, RTLS Controller sends the status data to the caller. Role Required: viewer Call Counter: Total: 3, Failed: 2	format (optional) - [String] format of output, compact or xml; default is xml	TAGSTATUS.tagid - [long] tag id TAGSTATUS.assetid - [long] asset identifier TAGSTATUS.mac - [String] MAC address TAGSTATUS.name - [String] device name TAGSTATS.type - [String] device type (such as t201 or t301) TAGSTATUS.reason - [String] description of the reason for status change TAGSTATUS.timestamp - [long] current time in milliseconds since January 1, 1970, 00:00:00 GMT TAGSTATUS.statustype - [Array] type of status that was changed (such as Dirtiness) TAGSTATUS.status - [Array] new status value (such as Clean) TAGSTATUS.statustime - [Array] status change time in milliseconds since January 1, 1970, 00:00:00 GMT
/epe/status/_clear		Input:	Output:
	Description: SPECIAL. Resets all service specific counters. Role Required: poweruser Call Counter: Total: 0, Failed: 0
/epe/status/_list POST version		Input:	Output:
	Description: SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions. Role Required: Call Counter: Total: 1, Failed: 0	help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.	COMMAND.name - [String] command name COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format
/epe/status/_status		Input:	Output:
	Description: SPECIAL. Returns status information about the service. Role Required: viewer Call Counter: Total: 0, Failed: 0		STATUS.callcount - [int] total number of calls for the service STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information

(The data in this page was generated from /epe/status/_list?help=1)